Register set-available-attachment-versions extension - #195
Conversation
Sets available-properties-tag / available-connect-version from what is actually in the content catalog so the UI's properties-json-url and connect-json-url meta tags never reference a JSON attachment that was not generated (top source of 404s: ~25k requests/day). Requires a docs-extensions-and-macros release containing redpanda-data/docs-extensions-and-macros#224. Co-Authored-By: Claude Fable 5 <[email protected]>
❌ Deploy Preview for redpanda-documentation failed. Why did it fail? →
|
|
Reviewed — the change itself is correct, but flagging that it isn't mergeable yet so it doesn't get picked up by mistake. The registration looks right. The extension is added to all three playbooks ( Not mergeable until #224 ships to npm. Confirming what your merge-order note says, since the PR isn't in draft state: $ node -p "require('./node_modules/@redpanda-data/docs-extensions-and-macros/package.json').version"
4.1.0
$ ls node_modules/@redpanda-data/docs-extensions-and-macros/extensions/set-available-attachment-versions.js
ls: ...: No such file or directoryThe One ordering note carried over from #224. In all three playbooks this sits before No changes needed on this PR beyond the merge gate. |
Review findings on this PR and dem#224: - The lockfile resolved 5.0.0, which predates the extension file, so merging would have broken the build. doc-tools 5.3.5 (published today) ships it; floor and lockfile bumped, install verified to contain extensions/set-available-attachment-versions.js. - Registration moved after version-fetcher/set-latest-version in all three playbooks: both hook contentClassified and Antora dispatches in registration order, and the tooltip-disable branch reads latest-redpanda-tag. Registering first worked only because every antora.yml pins a fallback tag.
|
Unblocked and hardened: doc-tools 5.3.5 with the extension is on npm, so this now carries the package.json floor + lockfile bump (install verified to contain the extension file), and registration moved after version-fetcher/set-latest-version in all three playbooks per the ordering fragility noted on dem#224. Ready for a look. |
2 participants
What
Registers the new
set-available-attachment-versionsAntora extension (redpanda-data/docs-extensions-and-macros#224) in all three playbooks.Why
The site's
properties-json-url/connect-json-urlmeta tags are built from release-tracking attributes that drift ahead of the generated JSON attachments, producing our top 404s (~25k requests/day) and silently breaking property tooltips onstreaming/current. The extension setsavailable-properties-tag/available-connect-versionfrom what actually exists in the catalog, and disables property tooltips on old streaming versions that have no properties JSON at all.Draft until a
@redpanda-data/docs-extensions-and-macrosrelease containing #224 is published — therequirepath doesn't exist in the currently installed package, so merging early breaks the build. After the release, re-runnpm update @redpanda-data/docs-extensions-and-macros(pin is^5.0.0) and mark ready.Related: docs-ui negative caching (redpanda-data/docs-ui#407), props v26.1.14 and connect 4.102.0 regeneration PRs (already open).
🤖 Generated with Claude Code